<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>formats</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;formats
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="formats-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="formats-module.html">Package formats</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: latin-1 -*-</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"># Copyright (c) 2009 Australian Government, Department of Environment, Heritage, Water and the Arts</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"># Permission is hereby granted, free of charge, to any person obtaining a copy</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"># of this software and associated documentation files (the "Software"), to deal</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"># in the Software without restriction, including without limitation the rights</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"># to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment"># copies of the Software, and to permit persons to whom the Software is</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment"># furnished to do so, subject to the following conditions:</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment"># The above copyright notice and this permission notice shall be included in</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment"># all copies or substantial portions of the Software.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment"># THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-comment"># IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-comment"># FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-comment"># AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-comment"># LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-comment"># OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-comment"># THE SOFTWARE.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">Image Metadata drivers</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">======================</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">Generic and custom image format drivers</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">B{Example}:</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; import formats</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; dataset = formats.open(somefile)</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; print dataset.extent</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">    [[139.214834,-20.155611],[139.28967,-20.170712],[139.403241,-19.311661],[139.47766,-19.326724]]</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; print dataset.metadata['filetype']</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">    CEOS/Landsat CCRS Format</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; print dataset.metadata['datatype']</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">    Int16</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">B{Adding support for another format}:</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">    - Create a new .py file. Name the .py file whatever you want as long as the filename doesn't begin with an underscore "_"</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">    - Define one or more "regular expression" strings to match your formats filename</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">    - Create a "Dataset" class that inherits either from the base __dataset__.Dataset class or from the __default__.Dataset class (See class hierarchy below)</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">    - The default Dataset class is useful if GDAL can read your format and you just need to populate some extra fields. </tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">    - Populate appropriate filelist &amp; fileinfo in the __init__ method of your dataset class (if required), do not populate the metadata dict!</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">    - Populate appropriate metadata and extent variables in the __getmetadata__ method of your dataset class</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">    - Your format will be automatically loaded when the formats module is initialised.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">    - Errors should be propagated back up the chain. If you can't handle a certain file and for some reason you don't want an error to get raised (eg. the ENVI driver (*.hdr) doesn't handle ESRI bil/flt headers (*.hdr)) then raise NotImplementedError which will be ignored in lib.formats.Open()</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">    - If you want some info to get logged by the application and then continue processing (e.g the image doesn't have a projection defined, etc...) then use the warnings.warn("Some message") method - don't forget to import the warnings module!</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    - Date/Time formats must follow follow AS ISO 8601-2007 (see: U{http://www.anzlic.org.au/metadata/guidelines/Index.html?date_and_datetime.htm})</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">B{Class hierarchy}::</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">    __dataset__.Dataset()</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">        | #Base Dataset class</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">        |</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">        |----.metadata={} #the metadata dictionary. </tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">        |                 #the metadata dictionary. </tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">        |                 #You can only populate fields defined in __fields__.py</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">        |                 #keys are immutable (values can be changed, but keys can't be</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">        |                 #added or deleted)</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">        |    </tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">        |----.filelist=[] #the list of related files</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">        |    </tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">        |----.fileinfo={      #file information</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">        |         'size':..., #doesn't included size of related files... TODO?</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">        |         'filename':...,</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">        |         'filepath':...,</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">        |         'guid':...,</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">        |         'metadatadate':...,</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">        |         'datemodified':...,</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">        |         'datecreated':...,</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">        |         'dateaccessed':...,</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">        |         'ownerid':...,</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">        |         'ownername':...</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">        |    }</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">        |    </tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">        |----.extent=[[x,y],[x,y],[x,y],[x,y]] </tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">        |     #Extent of the four corners in geographic (lon,lat) coordinates.</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring">        |     #May be rotated (eg. for path oriented images). Coordinate order</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">        |     #is irrelevant, as long as it doesn't create a self-intersecting</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">        |     #polygon.</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">        |</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">        |----getoverview(outfile=None,width=800,format='JPG'))</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">        |    #generate thumbnails and quicklooks</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">        |</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">        |----__new__(file)</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring">        |    #Initialise the class object and populate fileinfo</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">        |</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring">        |----__getfilelist__()</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">        |    #populate filelist</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">        |</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">        |----__default__.Dataset(__dataset__.Dataset)</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-docstring">        |   | #Default Dataset class</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-docstring">        |   |</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">        |   |----__getmetadata__(file)              </tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">        |   |     #Populate appropriate fields in the metadata dictionary</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">        |   |     #Populate extent list</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        |   |</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">        |   |----someformat.Dataset(__default__.Dataset)</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #Custom format inherits from subclass __default__.Dataset.</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">        |       |</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #Use this when GDAL can read most of the images metadata,</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #but you need to populate some other stuff as well</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #If you inherit from this, don't forget to call</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #__default__.Dataset.__getmetadata__(file) explicitly</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">        |       | #as your class will override this method</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">        |       |</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">        |       |----__init__(file)</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">        |           | #Populate/update filelist, fileinfo if required</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">        |           |</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">        |       |----__getmetadata__(file)</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">        |           | #Populate appropriate fields in the metadata dictionary</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">        |           | #Populate extent list</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">        |           |</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">        |           |----__default__.Dataset.__getmetadata__(file)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">        |                #Call superclass init explicitly</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">        |    </tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">        |----anotherformat.Dataset(__dataset__.Dataset)</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">            | #Custom format inherits from base class - __dataset__.Dataset</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">            |</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">            | #You need to populate basic metadata yourself.</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">            |</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">            |__init__(file)               </tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">            |  #Populate/update filelist, fileinfo if required</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">            |</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">            |__getmetadata__(file)                 </tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">            |  #Populate appropriate fields in the metadata dictionary</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">            |  #Populate extent list</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">@todo: Need to pass back info about import errors - warnings.warn perhaps?</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">@todo: More info re. geometric, radiometric corrections where available (ccrs,...)</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">@todo: __dataset__.__getfilelist__() does not handle different file formats with the same basename</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">       eg. dir/abc.jp2,dir/abc.j2i,dir/abc.tif,dir/abc.tfw</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring">       This could be handled with a bit of kludgery, but should it...? Can we assume that abc.jp2</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-docstring">       is the compressed version of abc.tif and should all be lumped together (as currently happens)?</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">glob</tt> <tt class="py-keyword">import</tt> <tt class="py-name">glob</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_glob</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_path</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_re</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_sys</tt><tt class="py-op">,</tt> <tt class="py-name">imp</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_imp</tt><tt class="py-op">,</tt> <tt class="py-name">warnings</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_warn</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module formats.__fields__=formats.__fields__-module.html"><a title="formats.__fields__" class="py-name" href="#" onclick="return doclink('link-0', '__fields__', 'link-0');">__fields__</a></tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Module utilities=utilities-module.html"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-1', 'utilities', 'link-1');">utilities</a></tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-comment">#Private</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt id="link-2" class="py-name" targets="Variable formats.__formats__=formats-module.html#__formats__"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-2', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-comment">#Public</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable formats.__default__.format_regex=formats.__default__-module.html#format_regex,Variable formats.ali_hyperion.format_regex=formats.ali_hyperion-module.html#format_regex,Variable formats.alos.format_regex=formats.alos-module.html#format_regex,Variable formats.aster.format_regex=formats.aster-module.html#format_regex,Variable formats.ccrs.format_regex=formats.ccrs-module.html#format_regex,Variable formats.digitalglobe.format_regex=formats.digitalglobe-module.html#format_regex,Variable formats.ecw.format_regex=formats.ecw-module.html#format_regex,Variable formats.ecwp.format_regex=formats.ecwp-module.html#format_regex,Variable formats.envi.format_regex=formats.envi-module.html#format_regex,Variable formats.esribil.format_regex=formats.esribil-module.html#format_regex,Variable formats.esrigrid.format_regex=formats.esrigrid-module.html#format_regex,Variable formats.fast_l7a.format_regex=formats.fast_l7a-module.html#format_regex,Variable formats.format_regex=formats-module.html#format_regex,Variable formats.jp2.format_regex=formats.jp2-module.html#format_regex,Variable formats.netcdf.format_regex=formats.netcdf-module.html#format_regex,Variable formats.nitf.format_regex=formats.nitf-module.html#format_regex,Variable formats.spot_cap.format_regex=formats.spot_cap-module.html#format_regex,Variable formats.spot_dimap.format_regex=formats.spot_dimap-module.html#format_regex"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-3', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-string">'''List of file path regular expressions defined by format drivers'''</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable formats.__fields__.fields=formats.__fields__-module.html#fields,Variable formats.fields=formats-module.html#fields"><a title="formats.__fields__.fields
formats.fields" class="py-name" href="#" onclick="return doclink('link-4', 'fields', 'link-4');">fields</a></tt><tt class="py-op">=</tt><tt id="link-5" class="py-name"><a title="formats.__fields__" class="py-name" href="#" onclick="return doclink('link-5', '__fields__', 'link-0');">__fields__</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="formats.__fields__.fields
formats.fields" class="py-name" href="#" onclick="return doclink('link-6', 'fields', 'link-4');">fields</a></tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-string">'''List of metadata fields that can be populated'''</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt id="link-7" class="py-name" targets="Variable formats.debug=formats-module.html#debug,Variable geometry.debug=geometry-module.html#debug"><a title="formats.debug
geometry.debug" class="py-name" href="#" onclick="return doclink('link-7', 'debug', 'link-7');">debug</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-comment">#Dynamically load all formats</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-keyword">for</tt> <tt id="link-8" class="py-name" targets="Variable formats._lib=formats-module.html#_lib"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-8', '_lib', 'link-8');">_lib</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">_glob</tt><tt class="py-op">(</tt><tt class="py-name">_path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">__path__</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt><tt class="py-string">'[a-z]*.py'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">    <tt id="link-9" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-9', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">=</tt><tt class="py-name">_path</tt><tt class="py-op">.</tt><tt class="py-name">splitext</tt><tt class="py-op">(</tt><tt class="py-name">_path</tt><tt class="py-op">.</tt><tt class="py-name">basename</tt><tt class="py-op">(</tt><tt id="link-10" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-10', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">        <tt class="py-comment">#import custom format and add to the list of formats</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">        <tt id="link-11" class="py-name"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-11', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">[</tt><tt id="link-12" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-12', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">]</tt><tt class="py-op">=</tt><tt class="py-name">__import__</tt><tt class="py-op">(</tt><tt class="py-string">'%s.%s'</tt><tt class="py-op">%</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt><tt id="link-13" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-13', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">fromlist</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">__name__</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">         </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">        <tt class="py-comment">#append module _format_regex &amp; fields to lists</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line">        <tt id="link-14" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-14', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-15" class="py-name" targets="Variable formats.r=formats-module.html#r"><a title="formats.r" class="py-name" href="#" onclick="return doclink('link-15', 'r', 'link-15');">r</a></tt> <tt class="py-keyword">for</tt> <tt id="link-16" class="py-name"><a title="formats.r" class="py-name" href="#" onclick="return doclink('link-16', 'r', 'link-15');">r</a></tt> <tt class="py-keyword">in</tt> <tt id="link-17" class="py-name"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-17', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">[</tt><tt id="link-18" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-18', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-19', 'format_regex', 'link-3');">format_regex</a></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-20" class="py-name"><a title="formats.r" class="py-name" href="#" onclick="return doclink('link-20', 'r', 'link-15');">r</a></tt> <tt class="py-keyword">in</tt> <tt id="link-21" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-21', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">    <tt class="py-comment">#except:pass </tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">        <tt class="py-name">_warn</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Unable to import %s\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-22" class="py-name"><a title="formats._lib" class="py-name" href="#" onclick="return doclink('link-22', '_lib', 'link-8');">_lib</a></tt><tt class="py-op">,</tt> <tt id="link-23" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-23', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-24" class="py-name" targets="Function utilities.ExceptionInfo()=utilities-module.html#ExceptionInfo"><a title="utilities.ExceptionInfo" class="py-name" href="#" onclick="return doclink('link-24', 'ExceptionInfo', 'link-24');">ExceptionInfo</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">  </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line"><tt class="py-comment">#import generic formats (eg. GeoTiff, JP2, etc...)</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-25" class="py-name" targets="Module formats.__default__=formats.__default__-module.html"><a title="formats.__default__" class="py-name" href="#" onclick="return doclink('link-25', '__default__', 'link-25');">__default__</a></tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line"><tt class="py-comment">#append module _format_regex to list of format regexes</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"><tt id="link-26" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-26', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-27" class="py-name" targets="Variable formats._r=formats-module.html#_r"><a title="formats._r" class="py-name" href="#" onclick="return doclink('link-27', '_r', 'link-27');">_r</a></tt> <tt class="py-keyword">for</tt> <tt id="link-28" class="py-name"><a title="formats._r" class="py-name" href="#" onclick="return doclink('link-28', '_r', 'link-27');">_r</a></tt> <tt class="py-keyword">in</tt> <tt id="link-29" class="py-name"><a title="formats.__default__" class="py-name" href="#" onclick="return doclink('link-29', '__default__', 'link-25');">__default__</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-30', 'format_regex', 'link-3');">format_regex</a></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-31" class="py-name"><a title="formats._r" class="py-name" href="#" onclick="return doclink('link-31', '_r', 'link-27');">_r</a></tt> <tt class="py-keyword">in</tt> <tt id="link-32" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-32', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line"> </tt>
<a name="Open"></a><div id="Open-def"><a name="L170"></a><tt class="py-lineno">170</tt> <a class="py-toggle" href="#" id="Open-toggle" onclick="return toggle('Open');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="formats-module.html#Open">Open</a><tt class="py-op">(</tt><tt class="py-param">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Open-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Open-expanded"><a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">    <tt class="py-docstring">''' Open an image with the appropriate driver.</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-docstring">        @type  f: C{str}</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring">        @param f: a filepath to the dataset to open.</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:   C{formats.Dataset}</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-docstring">        @return:  L{formats.Dataset&lt;formats.__dataset__.Dataset&gt;} object</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: perhaps log the entire error stack if a file couldn't be opened?</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">    <tt class="py-name">errors</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt> <tt class="py-comment">#error stack</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line">    <tt class="py-name">f</tt><tt class="py-op">=</tt><tt id="link-33" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-33', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Function utilities.encode()=utilities-module.html#encode"><a title="utilities.encode" class="py-name" href="#" onclick="return doclink('link-34', 'encode', 'link-34');">encode</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> <tt class="py-comment">#Issue 20</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line">    <tt class="py-name">f</tt><tt class="py-op">=</tt><tt id="link-35" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-35', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Function utilities.normcase()=utilities-module.html#normcase"><a title="utilities.normcase" class="py-name" href="#" onclick="return doclink('link-36', 'normcase', 'link-36');">normcase</a></tt><tt class="py-op">(</tt><tt id="link-37" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-37', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Function utilities.uncpath()=utilities-module.html#uncpath"><a title="utilities.uncpath" class="py-name" href="#" onclick="return doclink('link-38', 'uncpath', 'link-38');">uncpath</a></tt><tt class="py-op">(</tt><tt id="link-39" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-39', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Function utilities.realpath()=utilities-module.html#realpath"><a title="utilities.realpath" class="py-name" href="#" onclick="return doclink('link-40', 'realpath', 'link-40');">realpath</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">    <tt class="py-comment">#Try custom formats</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">lib</tt> <tt class="py-keyword">in</tt> <tt id="link-41" class="py-name"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-41', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">:</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">        <tt class="py-name">fr</tt><tt class="py-op">=</tt><tt class="py-string">'|'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-42" class="py-name"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-42', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">[</tt><tt class="py-name">lib</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="formats.__default__.format_regex
formats.ali_hyperion.format_regex
formats.alos.format_regex
formats.aster.format_regex
formats.ccrs.format_regex
formats.digitalglobe.format_regex
formats.ecw.format_regex
formats.ecwp.format_regex
formats.envi.format_regex
formats.esribil.format_regex
formats.esrigrid.format_regex
formats.fast_l7a.format_regex
formats.format_regex
formats.jp2.format_regex
formats.netcdf.format_regex
formats.nitf.format_regex
formats.spot_cap.format_regex
formats.spot_dimap.format_regex" class="py-name" href="#" onclick="return doclink('link-43', 'format_regex', 'link-3');">format_regex</a></tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">        <tt class="py-name">rx</tt><tt class="py-op">=</tt><tt class="py-name">_re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">fr</tt><tt class="py-op">,</tt> <tt class="py-name">_re</tt><tt class="py-op">.</tt><tt class="py-name">IGNORECASE</tt><tt class="py-op">)</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">rx</tt><tt class="py-op">.</tt><tt class="py-name">search</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line">                <tt class="py-name">ds</tt><tt class="py-op">=</tt><tt id="link-44" class="py-name"><a title="formats.__formats__" class="py-name" href="#" onclick="return doclink('link-44', '__formats__', 'link-2');">__formats__</a></tt><tt class="py-op">[</tt><tt class="py-name">lib</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Class formats.__dataset__.Dataset=formats.__dataset__.Dataset-class.html,Class formats.__default__.Dataset=formats.__default__.Dataset-class.html,Class formats.ali_hyperion.Dataset=formats.ali_hyperion.Dataset-class.html,Class formats.alos.Dataset=formats.alos.Dataset-class.html,Class formats.aster.Dataset=formats.aster.Dataset-class.html,Class formats.ccrs.Dataset=formats.ccrs.Dataset-class.html,Class formats.digitalglobe.Dataset=formats.digitalglobe.Dataset-class.html,Class formats.ecw.Dataset=formats.ecw.Dataset-class.html,Class formats.ecwp.Dataset=formats.ecwp.Dataset-class.html,Class formats.envi.Dataset=formats.envi.Dataset-class.html,Class formats.esribil.Dataset=formats.esribil.Dataset-class.html,Class formats.esrigrid.Dataset=formats.esrigrid.Dataset-class.html,Class formats.fast_l7a.Dataset=formats.fast_l7a.Dataset-class.html,Class formats.jp2.Dataset=formats.jp2.Dataset-class.html,Class formats.netcdf.Dataset=formats.netcdf.Dataset-class.html,Class formats.nitf.Dataset=formats.nitf.Dataset-class.html,Class formats.spot_cap.Dataset=formats.spot_cap.Dataset-class.html,Class formats.spot_dimap.Dataset=formats.spot_dimap.Dataset-class.html"><a title="formats.__dataset__.Dataset
formats.__default__.Dataset
formats.ali_hyperion.Dataset
formats.alos.Dataset
formats.aster.Dataset
formats.ccrs.Dataset
formats.digitalglobe.Dataset
formats.ecw.Dataset
formats.ecwp.Dataset
formats.envi.Dataset
formats.esribil.Dataset
formats.esrigrid.Dataset
formats.fast_l7a.Dataset
formats.jp2.Dataset
formats.netcdf.Dataset
formats.nitf.Dataset
formats.spot_cap.Dataset
formats.spot_dimap.Dataset" class="py-name" href="#" onclick="return doclink('link-45', 'Dataset', 'link-45');">Dataset</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">ds</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">:</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line">                <tt class="py-keyword">pass</tt> <tt class="py-comment">#Used when a format driver can't open a file, but doesn't want to raise an error</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt><tt class="py-name">err</tt><tt class="py-op">:</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt id="link-46" class="py-name"><a title="formats.debug
geometry.debug" class="py-name" href="#" onclick="return doclink('link-46', 'debug', 'link-7');">debug</a></tt><tt class="py-op">:</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">                    <tt class="py-name">errinfo</tt><tt class="py-op">=</tt><tt id="link-47" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-47', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Function utilities.FormatTraceback()=utilities-module.html#FormatTraceback"><a title="utilities.FormatTraceback" class="py-name" href="#" onclick="return doclink('link-48', 'FormatTraceback', 'link-48');">FormatTraceback</a></tt><tt class="py-op">(</tt><tt class="py-name">_sys</tt><tt class="py-op">.</tt><tt class="py-name">exc_info</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">,</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line">                    <tt class="py-name">errargs</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">arg</tt> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">err</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">]</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">                    <tt class="py-name">errargs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">errinfo</tt><tt class="py-op">)</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line">                    <tt class="py-name">err</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">=</tt><tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">errargs</tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line">                <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">err</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line">    <tt class="py-comment">#Try default formats</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">        <tt class="py-comment">#fr='|'.join(__default__.format_regex)</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line">        <tt class="py-comment">#rx=_re.compile(fr, _re.IGNORECASE)</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">        <tt class="py-comment">#if rx.search(f):</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line">        <tt class="py-name">ds</tt><tt class="py-op">=</tt><tt id="link-49" class="py-name"><a title="formats.__default__" class="py-name" href="#" onclick="return doclink('link-49', '__default__', 'link-25');">__default__</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="formats.__dataset__.Dataset
formats.__default__.Dataset
formats.ali_hyperion.Dataset
formats.alos.Dataset
formats.aster.Dataset
formats.ccrs.Dataset
formats.digitalglobe.Dataset
formats.ecw.Dataset
formats.ecwp.Dataset
formats.envi.Dataset
formats.esribil.Dataset
formats.esrigrid.Dataset
formats.fast_l7a.Dataset
formats.jp2.Dataset
formats.netcdf.Dataset
formats.nitf.Dataset
formats.spot_cap.Dataset
formats.spot_dimap.Dataset" class="py-name" href="#" onclick="return doclink('link-50', 'Dataset', 'link-45');">Dataset</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">ds</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">:</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> <tt class="py-comment">#Used when a format driver can't open a file, but doesn't want to raise an error</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt><tt class="py-name">err</tt><tt class="py-op">:</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-51" class="py-name"><a title="formats.debug
geometry.debug" class="py-name" href="#" onclick="return doclink('link-51', 'debug', 'link-7');">debug</a></tt><tt class="py-op">:</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line">            <tt class="py-name">errinfo</tt><tt class="py-op">=</tt><tt id="link-52" class="py-name"><a title="utilities" class="py-name" href="#" onclick="return doclink('link-52', 'utilities', 'link-1');">utilities</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="utilities.FormatTraceback" class="py-name" href="#" onclick="return doclink('link-53', 'FormatTraceback', 'link-48');">FormatTraceback</a></tt><tt class="py-op">(</tt><tt class="py-name">_sys</tt><tt class="py-op">.</tt><tt class="py-name">exc_info</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">,</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">            <tt class="py-name">errargs</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">arg</tt> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">err</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">]</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">            <tt class="py-name">errargs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">errinfo</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">            <tt class="py-name">err</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">=</tt><tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">errargs</tt><tt class="py-op">)</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line">        <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">err</tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">    <tt class="py-comment">#Couldn't open file, raise the last error in the stack</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">    <tt class="py-comment">#if len(errors) &gt; 0: raise errors[-1].__class__,'\n'.join(errors[-1].args) #Updated for Python 2.6, not all args are strings...</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">errors</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">errors</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">errors</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt><tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-string">'Unable to open %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">f</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line">    <tt class="py-string">'''@todo: perhaps log the entire error stack if a file couldn't be opened?'''</tt> </tt>
</div><a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    &nbsp;
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
